Skip to content

docs: trim core architecture guides and diagrams - #606

Merged
mfw78 merged 1 commit into
dev/m1from
docs/598-guide-core
Jul 25, 2026
Merged

docs: trim core architecture guides and diagrams#606
mfw78 merged 1 commit into
dev/m1from
docs/598-guide-core

Conversation

@mfw78

@mfw78 mfw78 commented Jul 25, 2026

Copy link
Copy Markdown
Contributor

What

Trim the core architecture guides (docs 00-04) and the diagram caption files to terse descriptions of the current contract, per the #598 house standard: cut rationale essays, grant-milestone and platform-target planning material, before/after narrative, and duplicated primitive-by-primitive prose. 0.3 version promises are reduced to current fact. Net ~770 lines removed.

Why

These are the canonical what-is-true-now guides and had drifted: they carried planning prose the rubric bans, stale crate/interface vocabulary, and several claims the current code no longer backs. Owner boundaries restored: 05 owns the SDK, 08 owns the venue layer and platform model; the core guides link them rather than duplicating.

Testing

Documentation-only, pure markdown: no build required. Verified every retained claim against crates/nexum-runtime (engine_config.rs limit keys/defaults, wit/nexum-host world imports, host/local_store_redb.rs namespacing and transaction model), confirmed no em dashes, confirmed no cross-doc links point at removed anchors.

AI Assistance

Documentation-only sweep; claims verified against the runtime source, and the markdown link graph checked for dangling references.

Deviations flagged

  • Local store is not per-event transactional. Docs 00/02/04 asserted an implicit per-event write transaction with all-or-nothing rollback on trap. crates/nexum-runtime/src/host/local_store_redb.rs (get/set/delete) opens and commits its own redb transaction per call, and host/impls/local_store.rs calls straight through with no supervisor-level wrapping, so a trap mid-event keeps already-committed writes. Docs corrected to per-call committed durability; the missing atomic-rollback guarantee is flagged here rather than papered over.
  • Local store isolation model. Docs 04/00 described one redb file per module; the code is a single redb file with a 32-byte keccak256(module_name) key prefix per ADR-0003 (local_store_redb.rs). Corrected in the docs.
  • shepherd:cow / cow-api superseded by the venue-adapter model. Docs 00/01/02 and both diagram files presented shepherd:cow/cow-api and a shepherd world as the shipped CoW contract. In the tree wit/shepherd-cow carries only cow-events, there is no cow-api host interface or OrderBookPool, and order submission is the videre:venue venue-adapter contract (wit/videre-venue, crates/cow-venue, crates/videre-sdk). Prose corrected to the venue model with a doc-08 pointer; the rendered diagram sources under docs/diagrams/*.mmd/*.png still show the old cow-api path and are marked historical pending regeneration (out of scope for a docs sweep).

Rewrite docs 00-04 and the diagram captions as terse descriptions of the current contract, cutting rationale essays, grant-milestone and platform-target planning material, and 0.3 version promises reduced to current fact.

Verify every retained claim against crates/nexum-runtime: engine.toml [limits] keys and defaults (fuel 1B, memory 64 MiB, state 50 MiB, deadline 120s), the six-primitive event-module world, and the single-file keccak256-prefixed local store (ADR-0003).

Correct substantive drift: module discovery is filesystem-only in 0.2 with ENS and registry as design direction; the shepherd:cow package now carries only cow-events and order submission is the videre:venue venue-adapter contract; the local store commits per host call rather than per event.

Part of #598.
@mfw78
mfw78 merged commit d0c5df5 into dev/m1 Jul 25, 2026
7 checks passed
@mfw78
mfw78 deleted the docs/598-guide-core branch July 25, 2026 06:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant